home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Workbench Design
/
WB Collection.iso
/
workbench werkzeuge
/
workbench erweiterungen
/
shellbench
/
shellbench.guide
(
.txt
)
< prev
next >
Wrap
Amigaguide Document
|
1996-04-07
|
44KB
|
960 lines
@database "ShellBench.guide"
@author Nick Christie
@$VER: ShellBench.guide 1.2 (22.12.95)
@(C) ShellBench.guide 1.2 Copyright
1995 Nick Christie
@width 70
@smartwrap
@remark This guide has been tested with BadLinks V1.17 by Roger Nedel.
@remark Thanks Roger!
@node Main "ShellBench.guide"
@title "ShellBench 1.2 Copyright
1995 Nick Christie"
@{code}
@{b}@{fg shine}ShellBench V1.2@{fg text}@{ub}
@{b}By Nick Christie@{ub}
@{b}22nd December 1995@{ub}
@{i}A Warm Welcome.@{ui}
@{" Introduction. " link IntroductionNode} What it's all about.
@{" Features. " link FeaturesNode } The best bits about it.
@{" Requirements. " link RequirementsNode} What you need.
@{i}Legal Bumph.@{ui}
@{" Distribution. " link DistributionNode} Some rules.
@{" Copyrights. " link CopyrightsNode } It's mine, all mine!
@{" Disclaimer. " link DisclaimerNode } But I'm not responsible.
@{" Package Contents. " link PackageNode } What's in the box.
@{i}The Important Bits@{ui}
@{" Installation. " link InstallationNode} How to get started.
@{" Starting and Quitting. " link StartingNode } And they're off!
@{" Using ShellBench. " link UsingNode } Finding your way around.
@{" Options Window. " link OptionsNode } You pays your money...
@{" Project Icons. " link ProjectNode } Automagic operation.
@{" ShellBench Tooltypes. " link TooltypesNode } Doing it your way.
@{i}Odds and Sods.@{ui}
@{" Bugs and Improvements. " link BugsNode } What could be better.
@{" Version History. " link VersionNode } In the beginning...
@{" Credits. " link CreditsNode } I'd like to thank...
@{" About BGUI. " link BGUINode } Jan's GUI system.
@{" About the Author. " link AuthorNode } The person responsible.
@{body}
This guide takes advantage of formatting commands introduced with V40
of AmigaGuide, however you should find that it works just fine with
earlier releases. At most, the line spacing may be a bit odd in places.@{par}
@endnode
@remark *********************************************************************
@node IntroductionNode "Introduction"
@{line}
@{b}@{fg shine}Introduction@{fg text}@{ub}@{line}
@{b}@{fg shine}============@{fg text}@{ub}@{par}
Let's face it, when Commodore put the Execute function in the menus of
Workbench 2, they only got it a quarter right. They seem to have a
knack of putting great features into the OS, but not taking proper
advantage of them when it came to utilities. File notification, public
screens, AppWindows, AppIcons... the list goes on. And so it was with
this Execute facility.@{par}
Have you ever been irritated by the way you have to type the whole
path for everything into the Execute requester? Been unable to use
Execute with some programs because they need a larger stack size?
Wanted to use Execute to run a program at a priority other than zero?@{par}
No? Ok, so you think you don't need ShellBench? What about...@{par}
...getting Shell programs to run from Workbench? Yeah, you can
double-click on them and get that nasty Execute requester again. Or
you can mess around with IconX and DOS scripts. Have fun.@{par}
Now there's an alternative. Read on, friend...@{par}
@endnode
@remark *********************************************************************
@node FeaturesNode "ShellBench: Features"
@{line}
@{b}@{fg shine}Features@{fg text}@{ub}@{line}
@{b}@{fg shine}========@{fg text}@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} Icons shift-selected when started from Workbench have their fully
qualified pathnames appended to the command string.@{line}
@{fg shine}
@{fg text} AppWindow support: drop icons in the window and the fully
qualified pathnames will be appended to the command.@{line}
@{fg shine}
@{fg text} TAB key performs filename completion.@{line}
@{fg shine}
@{fg text} Shift + TAB inserts all matching filenames.@{line}
@{fg shine}
@{fg text} Press Help to get a file requester; selected files get their full
pathnames inserted into the command string.@{line}
@{fg shine}
@{fg text} Optionally expands all wildcards in command before launch.@{line}
@{fg shine}
@{fg text} Command line history, which can be saved to a file for recall
between invocations of ShellBench.@{line}
@{fg shine}
@{fg text} Clipboard paste support using RightAmiga + V.@{line}
@{fg shine}
@{fg text} User-defined hotlist of favourite commands or substrings for quick
insertion via function keys.@{line}
@{fg shine}
@{fg text} Launch parameters such as output window, stack size, current
directory, etc, configurable via tooltypes and on-line via options
window.@{line}
@{fg shine}
@{fg text} Launch parameters can be placed in tooltypes of project icons,
allowing for easy launch of applications with specific execution
environments.@{line}
@{fg shine}
@{fg text} Commodity option, with user-configurable pop-up hotkey.@{line}
@{fg shine}
@{fg text} Opens on the default public screen, or on a named one.@{line}
@{fg shine}
@{fg text} Font-sensitive, resizeable gadget layout: uses the preferred font
of the screen it opens on, with a tooltype to override and specify
your own font.@{line}
@{fg shine}
@{fg text} All gadgets have keyboard shortcuts.@{line}
@{fg shine}
@{fg text} Locale support for presenting all text and messages in the
user-preferred language, with an option to override and specify
language.@{par}
@{lindent 0}
@endnode
@remark *********************************************************************
@node RequirementsNode "ShellBench: Requirements"
@{line}
@{b}@{fg shine}Requirements@{fg text}@{ub}@{line}
@{b}@{fg shine}============@{fg text}@{ub}@{par}
ShellBench requires:@{par}
@{lindent 2}
@{fg shine}
@{fg text} AmigaOS 2.04 / Kickstart V37 or higher.@{line}
@{fg shine}
@{fg text} bgui.library V38 or higher. @{i}(windows, gadgets, etc)@{ui}@{line}
@{lindent 0}
The following disk-based Commodore libraries are required, but are
part of AmigaOS 2.04 anyway:@{par}
@{lindent 2}
@{fg shine}
@{fg text} asl.library V37 or higher. @{i}(requesters)@{ui}@{line}
@{fg shine}
@{fg text} commodities.library V37 or higher. @{i}(commodity support)@{ui}@{line}
@{lindent 0}
The following disk-based Commodore libraries are optional, but their
absence will limit the functionality of ShellBench:@{par}
@{lindent 2}
@{fg shine}
@{fg text} iffparse.library V37 or higher. @{i}(clipboard support)@{ui}@{line}
@{fg shine}
@{fg text} diskfont.library V36 or higher. @{i}(custom font selection)@{ui}@{line}
@{fg shine}
@{fg text} locale.library V38 or higher. @{i}(localization)@{ui}@{line}
@{lindent 0}
All the above libraries are standard Commodore ones, except for @{"BGUI" link BGUINode},
which is by Jan van den Baard. Get it from your favourite PD supplier,
or from AmiNet in directory dev/gui.@{par}
@endnode
@remark *********************************************************************
@node DistributionNode "ShellBench: Distribution"
@{line}
@{b}@{fg shine}Distribution@{fg text}@{ub}@{line}
@{b}@{fg shine}============@{fg text}@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} ShellBench is Copyright
1995 by @{"Nick Christie" link AuthorNode}.
All rights are reserved.@{line}
@{fg shine}
@{fg text} ShellBench is "freeware" so no donation is required. It is *not*
in the public domain.@{line}
@{fg shine}
@{fg text} ShellBench may be freely distributed provided all the files listed
in @{"Contents" link PackageNode} remain unaltered and are included in the distribution.
They may, however, be archived to conserve space.@{line}
@{fg shine}
@{fg text} No profit is to be made by selling this software. You may only
charge enough to cover reasonable production and distribution
costs.@{line}
@{fg shine}
@{fg text} This software may not be included in a commercial package, or on a
magazine coverdisk, without the author's written permission.@{line}
@{fg shine}
@{fg text} This software may not be uploaded onto any BBS that claims
copyright on uploaded material.@{line}
@{fg shine}
@{fg text} If you use ShellBench, I would enjoy receiving a postcard or email
from you. See my @{"addresses" link AuthorNode}.@{line}
@{lindent 0}
@endnode
@remark *********************************************************************
@node CopyrightsNode "ShellBench: Copyrights"
@{line}
@{b}@{fg shine}Copyrights@{fg text}@{ub}@{line}
@{b}@{fg shine}==========@{fg text}@{ub}@{par}
@{code}
The @{"BGUI" link BGUINode} library is Copyright
1993-4 Jaba Development/Jan van den Baard.
Amiga, AmigaDOS, AmigaGuide, Workbench and Kickstart
are registered trademarks of Amiga Technology GmbH.
@{body}
@endnode
@remark *********************************************************************
@node DisclaimerNode "ShellBench: Disclaimer"
@{line}
@{b}@{fg shine}Disclaimer@{fg text}@{ub}@{line}
@{b}@{fg shine}==========@{fg text}@{ub}@{par}
This program is provided "as is" without warranty of any kind, either
expressed or implied, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose.
The entire risk as to the quality and performance of this program is
with you. In no event can I be liable to you for damages of any kind
arising out of the use of this program, or the inability to use it.@{par}
@endnode
@remark *********************************************************************
@node PackageNode "ShellBench: Package Contents"
@{line}
@{b}@{fg shine}Package Contents@{fg text}@{ub}@{line}
@{b}@{fg shine}================@{fg text}@{ub}@{par}
This package consists of:@{par}
@{code}
ShellBench The program itself.
ShellBench.info 8 colour icon for above.
def_ShellBench.info 8 colour project icon.
ShellBench.readme Program overview in text format.
ShellBench.readme.info 8 colour icon for above.
ShellBench.guide Documentation in AmigaGuide format.
ShellBench.guide.info 8 colour icon for above.
Shellbench.install Installation script.
Shellbench.install.info 8 colour icon for above.
ShellBench.pi Product-Info file for databases.
Catalogs/ShellBench.cd Catalog generation files.
Catalogs/ShellBench.ct
Icons/ShellBench.4clr.info 4 colour icon for above.
Icons/def_ShellBench.4clr.info 4 colour project icon.
@{body}
@endnode
@remark *********************************************************************
@node InstallationNode "ShellBench: Installation"
@{line}
@{b}@{fg shine}Installation@{fg text}@{ub}@{line}
@{b}@{fg shine}============@{fg text}@{ub}@{par}
A script for Commodore's Installer utility is provided, just double
click on the install icon. If you don't already have a copy of
Installer, it's available from AmiNet (in directory util/misc) or from
Fish Disk #870.@{par}
If you prefer to perform the installation by hand:@{par}
@{lindent 2}
@{fg shine}
@{fg text} copy ShellBench anywhere you like,@{par}
@{lindent 0}
Optionally:@{par}
@{lindent 2}
@{fg shine}
@{fg text} copy ShellBench.guide wherever you keep guides, and set
ShellBench's @{"GUIDENAME" link CONFIGTOOLNode} tooltype to point to it if it's not on
AmigaGuide's search path;@{line}
@{fg shine}
@{fg text} def_ShellBench is an example icon you may like to use for your
ShellBench projects - copy it anywhere you like;@{line}
@{fg shine}
@{fg text} copy the catalog file for your preferred language to
"LOCALE:Catalogs/<language>/ShellBench.catalog".@{line}
@{lindent 0}
Remember to check that the DONOTWAIT tooltype is present if you put
ShellBench in WBStartup. In addition, set its @{"CX_POPUP" link CXTOOLNode} tooltype to
FALSE, so that it doesn't open its window every time you boot
up.@{par}
@endnode
@remark *********************************************************************
@node StartingNode "ShellBench: Starting and Quitting"
@{line}
@{b}@{fg shine}Starting and Quitting@{fg text}@{ub}@{line}
@{b}@{fg shine}=====================@{fg text}@{ub}@{par}
@{b}To start ShellBench from the Workbench:@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} Double click on its icon, or@{line}
@{fg shine}
@{fg text} Create a @{"project icon" link ProjectNode} with some ShellBench @{"tooltypes" link TooltypesNode} and make
ShellBench its default tool, then double click on that.@{line}
@{lindent 0}
Note that ShellBench's default behaviour is to open its window on
start-up. To change this, set the tooltype @{"CX_POPUP" link CXTOOLNode} to NO.@{par}
By shift-selecting other icons and then double clicking on ShellBench,
you can make other useful things happen: see @{"Project Icons" link ProjectNode}.@{par}
@{b}To start ShellBench from a Shell:@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} Change to the directory in which you installed it, or add that
directory to your shell path, and enter 'ShellBench'. If you want
your Shell back you'll have to 'Run' it. There are no command line
arguments: ShellBench will look for its icon in its home directory
and read the tooltypes in it.@{line}
@{lindent 0}
@{b}To open ShellBench's window when it is hidden:@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} Press the pop-up hotkey combination. The default is "RCommand
RShift E", which means press 'E' while holding down the right Amiga
and shift keys but you can change this with the @{"CX_POPKEY" link CXTOOLNode} tooltype.
Or,@{line}
@{fg shine}
@{fg text} Double click on the ShellBench icon again (assuming that it does
not have the @{"COMMODITY" link CXTOOLNode} tooltype set to NO), or@{line}
@{fg shine}
@{fg text} Start the Exchange program, find ShellBench in the list, select it
and click on the [Show] button@{line}
@{lindent 0}
@{b}To close ShellBench's window, without quitting the program (only
possible when installed as a commodity):@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} Click on the close window gadget, or@{line}
@{fg shine}
@{fg text} Click on the [Hide] button, or@{line}
@{fg shine}
@{fg text} Press Esc, or@{line}
@{fg shine}
@{fg text} Start the Exchange program, find ShellBench in the list, select it
and click on the [Hide] button.@{line}
@{lindent 0}
@{b}To quit ShellBench, removing it from memory:@{ub}@{par}
@{lindent 2}
@{fg shine}
@{fg text} Click on the close window gadget (if not a commodity), or@{line}
@{fg shine}
@{fg text} Click on the [Quit] button in its window, or@{line}
@{fg shine}
@{fg text} De-activate the command string gadget (by pressing Shift + Return)
and press Q for quit (if ShellBench is not a commodity, just press
Esc). Or,@{line}
@{fg shine}
@{fg text} Start the Exchange program, find ShellBench in the list, select it
and click on the [Kill] button, or@{line}
@{fg shine}
@{fg text} Send it a Control-C signal using the AmigaDOS Break command.@{line}
@{lindent 0}
Right, that's the basics, now get down the more useful part: actually
@{"using the program" link UsingNode}.@{par}
@endnode
@remark *********************************************************************
@node UsingNode "ShellBench: Using ShellBench"
@{line}
@{b}@{fg shine}Using ShellBench@{fg text}@{ub}@{line}
@{b}@{fg shine}================@{fg text}@{ub}@{par}
@{b}Window and Gadgets@{ub}@{line}
@{b}------------------@{ub}@{par}
The ShellBench window consists of a string gadget for entering the
desired AmigaDOS command, plus several button gadgets:@{par}
[Execute] launches the command (if you've typed one in) and closes the
ShellBench window.@{par}
[Options...] opens a window with various gadgets for setting the
environment for launched commands - see the @{"Options Window" link OptionsNode}.@{par}
[Hide] closes the ShellBench window without launching the command, but
leaves ShellBench running (only available if installed as a
commodity).@{par}
[Quit] quits ShellBench.@{par}
@{b}AppWindow@{ub}@{line}
@{b}---------@{ub}@{par}
The ShellBench window is an AppWindow: icons dropped on to it get
their full pathnames appended to the current command string. You can
disable this facility with the @{"APPWINDOW" link WINTOOLNode} tooltype, if you wish.@{par}
@{b}Keyboard Control@{ub}@{line}
@{b}----------------@{ub}@{par}
Keypresses can be used to control the gadgets, just press the key
underlined in the gadget label. However, the command string gadget is
normally active and anything you type goes in there. The answer is to
press Shift + Return, which deactivates the string gadget without
launching the command or closing the window.@{par}
Here are some other useful keypresses, which work whether the string
gadget is active or not:@{par}
@{code}
Esc closes the window without launching the command.
Return launches the command and closes the window.
Ctrl + Return launches the command, keeping the window open.
Help opens ShellBench's AmigaGuide documentation.
@{body}
@{b}Command Launching@{ub}@{line}
@{b}-----------------@{ub}@{par}
When ShellBench launches a command, it does so asynchronously. This is
like using 'Run' and means you can continue to use ShellBench while
the launched program executes. The environment of the launched command
is highly configurable - see the @{"Options Window" link OptionsNode} for more info.@{par}
@{b}Move by Word@{ub}@{line}
@{b}------------@{ub}@{par}
In addition to the usual string gadget editing keys supported by
Intuition, you can press Control plus left and right cursor keys to
move the cursor to the next or previous word.@{par}
@{b}History Buffer@{ub}@{line}
@{b}--------------@{ub}@{par}
Launched commands are added to a history buffer; use the cursor up and
down keys to move through the available selection. When you quit
ShellBench, it saves the history to a file for use next time you run
the program. When the history buffer is full, new lines overwrite the
oldest lines. You can control the operation of the history buffer with
the @{"HISTORYLINES, HISTORYSAVE and HISTORYFILE" link CMDEDITTOOLNode} tooltypes.@{par}
@{b}Filename Completion@{ub}@{line}
@{b}-------------------@{ub}@{par}
When typing in a filename, instead of entering the whole name, type in
the first few characters and press TAB; ShellBench will complete the
name for you. If more than one file matches what you've typed, press
TAB repeatedly to cycle through the available matches. This also works
with wildcard patterns, for example, enter "docs:*.doc" and press TAB.@{par}
By default, ShellBench's pattern matching and filename completion
includes ".info" icon files. If you would prefer these to be excluded,
deselect the [Match .info] checkbox in the @{"Options Window" link OptionsNode}. You can
also set your preferred initial setting for this option using the
@{"MATCHINFO" link CMDEDITTOOLNode} tooltype.@{par}
@{b}Inserting all Matches@{ub}@{line}
@{b}---------------------@{ub}@{par}
To insert all filenames that match a pattern such as "*.doc", press
Shift + TAB. Use the [Match .info] checkbox in the Options Window
to include or exclude icon files.@{par}
@{b}Inserting a Name via File Requester@{ub}@{line}
@{b}-----------------------------------@{ub}@{par}
Pressing Shift + Help in the string gadget opens a file requester,
select a file or directory name and it will be inserted into the
command at the cursor position. If you type in a directory, such as
"GAMES:", and then press Shift + Help, the file requester will open in
that directory.@{par}
@{b}Clipboard Paste@{ub}@{line}
@{b}---------------@{ub}@{par}
RightAmiga + V inserts the contents of the clipboard into the string
gadget, assuming of course that the clipboard contains some text. You
can disable this facility with the @{"CLIPPASTE" link CMDEDITTOOLNode} tooltype, if you wish.@{par}
@{b}Insert Hotlist String@{ub}@{line}
@{b}---------------------@{ub}@{par}
The function keys F1 to F10 can be programmed with your favourite
commands or phrases using @{"tooltypes" link CMDEDITTOOLNode}. The phrase will be inserted into
the string gadget at the cursor position.@{par}
@{b}Wildcard Expansion@{ub}@{line}
@{b}------------------@{ub}@{par}
When you launch a command, ShellBench will first expand all wildcard
patterns it finds in the command. For example, if you entered "more
docs:*.doc" it would expand "docs:*.doc", replacing it with all
matching file and directory names. Words in the command which are
enclosed in double quotes (") will always be left unexpanded. The
[Expand Wild] checkbox gadget in the @{"Options Window" link OptionsNode} offers dynamic
control over this behaviour: when it is checked, wildcards will be
expanded; otherwise the command will be launched as it is. Use the
@{"EXPANDWILD" link CMDENVTOOLNode} tooltype to specify your preferred initial setting.@{par}
If the [Match .info] checkbox in the Options Window is selected,
'.info' icon files will be included in the pattern matching, otherwise
they will be excluded.@{par}
@endnode
@remark *********************************************************************
@node OptionsNode "ShellBench: Options Window"
@{line}
@{b}@{fg shine}Options Window@{fg text}@{ub}@{line}
@{b}@{fg shine}==============@{fg text}@{ub}@{par}
You can set the environment for launched commands permanently using
@{"tooltypes" link TooltypesNode}, or dynamically using the Options window. Open this window
using the [Options...] button in the main ShellBench window.@{par}
This window is also an AppWindow - if you drop a ShellBench project
icon on it, the values in the appropriate tooltypes of the icon will
be put into the gadgets. See @{"Project Icons" link ProjectNode} for more info.@{par}
@{b}Output@{ub}@{line}
@{b}------@{ub}@{par}
Type in the desired output filename for the command. Usually you will
want the output to go to a console window, which is the default.@{par}
@{b}Cur.Dir@{ub}@{line}
@{b}-------@{ub}@{par}
Enter the desired current directory for launched programs, or click on
the button to the right to pick one using a requester. If you leave
this blank, the program will inherit ShellBench's current directory.@{par}
@{b}Path@{ub}@{line}
@{b}----@{ub}@{par}
When started from Workbench, ShellBench clones Workbench's search
path. When started from a Shell, it inherits the shell's path.
Launched commands also inherit this path. With this gadget, you can
add directories to the beginning of this list: just type in the
directory names, separated by commas (,). Use the button to the right
to select directories using a requester.@{par}
@{b}Stack@{ub}@{line}
@{b}-----@{ub}@{par}
Sets the size, in bytes, of the command's stack. The default of 8000
bytes is appropriate for most software. Take care if lowering this, as
the command may need more and crash unexpectedly as a result.@{par}
@{b}Priority@{ub}@{line}
@{b}--------@{ub}@{par}
You can select the task priority the command should have, ie. how much
CPU attention it should get. You should generally stick to values
between -3 and 3. The default is 0.@{par}
@{b}Expand Wild@{ub}@{line}
@{b}-----------@{ub}@{par}
This checkbox governs whether ShellBench should try to expand wildcard
patterns in the command line before launch. Remember that anything
enclosed in double quotes (") will never be expanded.@{par}
@{b}Match .info@{ub}@{line}
@{b}-----------@{ub}@{par}
When ShellBench performs filename completion or pattern matching, it
will include '.info' icon files if this checkbox is selected.
Deselecting the checkbox will cause ShellBench to exclude those files
from all pattern matching operations.@{par}
@{b}Shell@{ub}@{line}
@{b}-----@{ub}@{par}
Normally commands are sent to the default user shell for processing,
which means the AmigaDOS shell for most people. If you would like the
command to be interpreted by some other shell, enter its name in this
gadget.@{par}
@{b}Okay@{ub}@{line}
@{b}----@{ub}@{par}
Keeps the settings for this session only.@{par}
@{b}Save to Icon@{ub}@{line}
@{b}------------@{ub}@{par}
Saves the current settings to the tooltypes of an icon. A file
requester appears for you to select the icon with. You can either
select an existing icon, or type in the name of a new one that
ShellBench should create. When creating new icons, ShellBench will use
the default project icon set with the @{"DEFICON" link CONFIGTOOLNode} tooltype. If that fails,
the system default project icon is used.@{par}
If the command string gadget in the main ShellBench window has a
command in it, this will also be put in the icon using the @{"COMMAND" link PROJTOOLNode}
tooltype. The @{"LAUNCH" link PROJTOOLNode} tooltype will also be inserted, with a value of
YES. You can quickly create ShellBench @{"project icons" link ProjectNode} using this
method.@{par}
@{b}Cancel@{ub}@{line}
@{b}------@{ub}@{par}
Closes the Options window, discarding any changes you may have made to
the settings.@{par}
@endnode
@remark *********************************************************************
@node ProjectNode "ShellBench: Project Icons"
@{line}
@{b}@{fg shine}Project Icons@{fg text}@{ub}@{line}
@{b}@{fg shine}=============@{fg text}@{ub}@{par}
Icons shift-selected from Workbench get their full pathnames inserted
into the command string gadget. As a special case, the first icon is
examined for the SHELLBENCH tooltype, which marks it as a ShellBench
project icon. If this tooltype is found, the other ShellBench
tooltypes are searched for and processed (eg. STACKSIZE, OUTPUT).@{par}
ShellBench project icons can also contain the COMMAND and LAUNCH
tooltypes. COMMAND specifies the initial contents of the command
string gadget, LAUNCH (YES or NO) specifies whether the command should
be executed immediately (default, YES). Once the command is launched,
ShellBench will quit.@{par}
The above also applies to project icons which have ShellBench as their
default tool.@{par}
An example should clarify this. Take a project icon, set its default
tool to be ShellBench and enter the following tooltypes:@{par}
@{code}
SHELLBENCH
COMMAND=LIST QUICK
LAUNCH=YES
@{body}
Now click on the project icon and shift-double-click on your RamDisk
icon. You should get a window with a short listing of the files in
RAM:. Unfortunately, the icon you use cannot be a tool, as Workbench
will try to launch that as a program.@{par}
You can create these project icons easily using the @{"Options window" link OptionsNode}.@{par}
@endnode
@remark *********************************************************************
@node TooltypesNode "ShellBench: ShellBench Tooltypes"
@{line}
@{b}@{fg shine}ShellBench Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}====================@{fg text}@{ub}@{par}
The tooltypes are examined even if ShellBench is started from a Shell.
You can use most of these tooltypes both in the icon for ShellBench
and in ShellBench @{"project icons" link ProjectNode}.@{par}
ShellBench's tooltypes consist of three kinds:@{par}
@{lindent 2}
@{b}String@{ub} - You must supply a string of some kind; a filename,
public screen name, etc. For example, "LANGUAGE=deutsch".@{par}
@{b}Integer@{ub} - You must supply a numeric value (a whole number).
For example, "STACKSIZE=4096".@{par}
@{b}Boolean@{ub} - In tooltypes you must supply one of the following: YES, NO,
TRUE or FALSE. For example, "CX_POPUP=YES". You can also omit the
value entirely, which indicates the YES or TRUE state. On a Shell
command line, just state the keyword without a value to get the TRUE
state, omit the keyword for FALSE.@{par}
@{lindent 0}
@{code}
Tooltype Type Short Description
------------ ---- --------------------------------------
@{"Project Icon Only Tooltypes" link PROJTOOLNode}
SHELLBENCH N/A Identifies a ShellBench project.
COMMAND STR Command to execute.
LAUNCH BOOL Whether to launch the command.
@{"Command Environment" link CMDENVTOOLNode}
OUTPUT STR Where to send command output.
STACKSIZE INT Stack size for command.
PRIORITY INT Task priority for command.
CURRENTDIR STR Current directory for command.
PATH STR Additional directories for search path.
CUSTOMSHELL STR Custom shell to send command to.
EXPANDWILD BOOL Whether to expand wildcards.
@{"Command Editing" link CMDEDITTOOLNode}
MATCHINFO BOOL Whether to match '.info' files.
HISTORYLINES INT Number of lines in history buffer.
HISTORYSAVE BOOL Whether to save history on exit.
HISTORYFILE STR Filename to save history to.
CLIPPASTE BOOL Whether to enable clipboard pasting.
F1-F10 STR Define substrings for function keys.
@{"Commodity" link CXTOOLNode}
COMMODITY BOOL Whether commodity operation is enabled.
CX_POPUP BOOL Whether to open window on start up.
CX_POPKEY STR Commodities popup hotkey definition.
CX_PRIORITY INT Priority of hotkey among commodities.
@{"Window Settings" link WINTOOLNode}
PUBSCREEN STR Public screen to open window on.
WINDOWFONT STR Font to use in window.
APPWINDOW BOOL Whether AppWindow operation is enabled.
WINDOWLEFT INT Initial window left-edge position.
WINDOWTOP INT Initial window top-edge position.
WINDOWWIDTH INT Initial window width.
@{"General Configuration" link CONFIGTOOLNode}
LANGUAGE STR Non-default language to use.
GUIDENAME STR Location of documentation.
DEFICON STR Icon to use for saved projects.
@{body}
If you put ShellBench in your WBStartUp drawer, you should add the
tooltype DONOTWAIT so Workbench won't wait for ShellBench to quit
before continuing with its start up.@{par}
@endnode
@remark *********************************************************************
@node PROJTOOLNode "ShellBench: Project Icon Only Tooltypes"
@{line}
@{b}@{fg shine}Project Icon Only Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}===========================@{fg text}@{ub}@{par}
These tooltypes are applicable to ShellBench @{"project icons" link ProjectNode} only.@{par}
@{b}SHELLBENCH@{ub}@{line}
@{b}----------@{ub}@{par}
Type: N/A@{line}
Default: N/A@{par}
The presence of this tooltype identifies a ShellBench project. It
doesn't require a value.@{par}
@{b}COMMAND@{ub}@{line}
@{b}-------@{ub}@{par}
Type: String@{line}
Default: none@{par}
The command that this project icon should execute.@{par}
@{b}LAUNCH@{ub}@{line}
@{b}------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Whether to actually launch the command given by the COMMAND tooltype.@{par}
@endnode
@remark *********************************************************************
@node CMDENVTOOLNode "ShellBench: Command Environment Tooltypes"
@{line}
@{b}@{fg shine}Command Environment Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}=============================@{fg text}@{ub}@{par}
You can use these tooltypes in ShellBench @{"project icons" link ProjectNode}, too.@{par}
@{b}OUTPUT@{ub}@{line}
@{b}------@{ub}@{par}
Type: String@{line}
Default: CON:0/20/600/140/ShellBench Output/AUTO/CLOSE/WAIT@{par}
Where to direct command output to. Usually this will be a console
window, but you can specify a file, if you like.@{par}
@{b}STACKSIZE@{ub}@{line}
@{b}---------@{ub}@{par}
Type: Integer@{line}
Limits: Min. 4000 (suggested).@{line}
Default: 8000@{par}
Stack size in bytes to give command. Take care if lowering this,
because if the command needs more stack than you give it, it may
crash.@{par}
@{b}PRIORITY@{ub}@{line}
@{b}--------@{ub}@{par}
Type: Integer@{line}
Limits: Max. 3 (suggested), min. -127.@{line}
Default: 0@{par}
Task priority to give command.@{par}
@{b}CURRENTDIR@{ub}@{line}
@{b}----------@{ub}@{par}
Type: String@{line}
Default: Inherited from ShellBench@{par}
Current directory to give command.@{par}
@{b}PATH@{ub}@{line}
@{b}----@{ub}@{par}
Type: String@{line}
Default: Inherited from ShellBench@{par}
Search path to give command. Separate multiple directories with commas
(,). ShellBench will append the original (WB or Shell) search path to
the directories specified.@{par}
@{b}CUSTOMSHELL@{ub}@{line}
@{b}-----------@{ub}@{par}
Type: String@{line}
Default: System default user shell@{par}
Name of custom shell to send command to.@{par}
@{b}EXPANDWILD@{ub}@{line}
@{b}----------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Whether to expand wildcards in command before launching. This tooltype
sets the initial condition of the [Expand Wild] checkbox in the
@{"Options Window" link OptionsNode}.@{par}
@endnode
@remark *********************************************************************
@node CMDEDITTOOLNode "ShellBench: Command Editing Tooltypes"
@{line}
@{b}@{fg shine}Command Editing Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}=========================@{fg text}@{ub}@{par}
@{b}MATCHINFO@{ub}@{line}
@{b}---------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Whether to include '.info' icon files in pattern matching operations.
You can use this tooltype in ShellBench @{"project icons" link ProjectNode}, too.@{par}
@{b}HISTORYLINES@{ub}@{line}
@{b}------------@{ub}@{par}
Type: Integer@{line}
Limits: Min. 0.@{line}
Default: 20@{par}
Maximum number of lines to keep in history buffer. When the buffer is
full, new lines replace the oldest lines. If you supply a value of 0,
the history facility will be disabled.@{par}
@{b}HISTORYSAVE@{ub}@{line}
@{b}-----------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Whether to save the history buffer to a file on exit.@{par}
@{b}HISTORYFILE@{ub}@{line}
@{b}-----------@{ub}@{par}
Type: String@{line}
Default: ENV:ShellBench.history@{par}
Name and path of file to read/write history buffer from/to.@{par}
@{b}CLIPPASTE@{ub}@{line}
@{b}---------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Enables RightAmiga + V clipboard paste in command string gadget.@{par}
@{b}F1 - F10@{ub}@{line}
@{b}--------@{ub}@{par}
Type: String@{line}
Default: None (empty strings)@{par}
Hotlist string for function key 'n' (1-10).@{par}
@endnode
@remark *********************************************************************
@node CXTOOLNode "ShellBench: Commodity Tooltypes"
@{line}
@{b}@{fg shine}Commodity Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}===================@{fg text}@{ub}@{par}
@{b}COMMODITY@{ub}@{line}
@{b}---------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Whether ShellBench should install as a commodity.@{par}
@{b}CX_POPUP@{ub}@{line}
@{b}--------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Whether to open window when started as a commodity.@{par}
@{b}CX_POPKEY@{ub}@{line}
@{b}---------@{ub}@{par}
Type: String@{line}
Default: RCommand RShift e@{par}
Pop-up hotkey definition. It is legal to omit the value, which
suppresses the creation of a hotkey, eg. "CX_POPKEY=".@{par}
@{b}CX_PRIORITY@{ub}@{line}
@{b}-----------@{ub}@{par}
Type: Integer@{line}
Limits: Max. 127. Min. -128.@{line}
Default: 0@{par}
Hotkey priority among commodities.@{par}
@endnode
@remark *********************************************************************
@node WINTOOLNode "ShellBench: Window Setting Tooltypes"
@{line}
@{b}@{fg shine}Window Setting Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}========================@{fg text}@{ub}@{par}
@{b}PUBSCREEN@{ub}@{line}
@{b}---------@{ub}@{par}
Type: String@{line}
Default: none (system default public screen)@{par}
Name of public screen to open window on.@{par}
@{b}WINDOWFONT@{ub}@{line}
@{b}----------@{ub}@{par}
Type: String@{line}
Default: none (screen default font)@{par}
Name and size of font to use in window, eg. "example.font/15". A
minimum font size of 6 is enforced.@{par}
@{b}APPWINDOW@{ub}@{line}
@{b}---------@{ub}@{par}
Type: Boolean@{line}
Default: TRUE@{par}
Enables AppWindow behaviour: icons dropped on ShellBench window get
their full pathnames appended to the command string.@{par}
@{b}WINDOWLEFT/TOP/WIDTH@{ub}@{line}
@{b}--------------------@{ub}@{par}
Type: Integer@{line}
Limits: Min. 0.@{line}
Default: under mouse pointer, two thirds width of screen@{par}
Define the initial position and width of the ShellBench window.@{par}
@endnode
@remark *********************************************************************
@node CONFIGTOOLNode "ShellBench: General Configuration Tooltypes"
@{line}
@{b}@{fg shine}General Configuration Tooltypes@{fg text}@{ub}@{line}
@{b}@{fg shine}===============================@{fg text}@{ub}@{par}
@{b}LANGUAGE@{ub}@{line}
@{b}--------@{ub}@{par}
Type: String@{line}
Default: system default language@{par}
Overrides system default language, used for selecting the catalog file
on systems that support locale (WB2.1 upwards).@{par}
@{b}GUIDENAME@{ub}@{line}
@{b}---------@{ub}@{par}
Type: String@{line}
Default: ShellBench.guide@{par}
Defines the name and location of ShellBench's AmigaGuide
documentation.@{par}
@{b}DEFICON@{ub}@{line}
@{b}-------@{ub}@{par}
Type: String@{line}
Default: def_ShellBench@{par}
The path and name of the default project icon that ShellBench should
use with the Save to Icon facility in the Options window. Leave out
the ".info" ending.@{par}
@endnode
@remark *********************************************************************
@node BugsNode "ShellBench: Bugs and Improvements"
@{line}
@{b}@{fg shine}Bugs and Improvements@{fg text}@{ub}@{line}
@{b}@{fg shine}=====================@{fg text}@{ub}@{par}
No known bugs at this time.@{par}
Suggested improvements in no particular order:@{par}
@{lindent 2}
@{fg shine}
@{fg text} delete by word in string gadget using CONTROL+BS and DEL.@{line}
@{fg shine}
@{fg text} MUI based version.@{line}
@{lindent 0}
Please send bug reports or further suggestions to @{"me" link AuthorNode}.@{par}
Translations of the catalog would be greatly appreciated; please send
them to me for inclusion in the next release.@{par}
@endnode
@remark *********************************************************************
@node VersionNode "ShellBench: Version History"
@{line}
@{b}@{fg shine}Version History@{fg text}@{ub}@{line}
@{b}@{fg shine}===============@{fg text}@{ub}@{par}
@{b}1.0 (30.4.95)@{ub}@{line}
@{b}--------------@{ub}@{par}
First release.@{par}
@{b}1.1 (30.11.95)@{ub}@{line}
@{b}--------------@{ub}@{par}
New: Added STRINGA_MinCharsVisible tag to stack and priority options
gadgets.@{par}
New: MATCHINFO tooltype, if FALSE, excludes '.info' files from all
pattern matching. Default is TRUE, ie. '.info' files are included.@{par}
New: Rearranged Options window layout slightly; added 'Match .info'
checkbox to Options window and changed 'Exp.Wild' gadget label to
'Expand Wild' in English catalog.@{par}
New: Added on-line (synchronous) help accessed by pressing Help key.
Now uses Shift + Help to insert filenames using a requester.@{par}
New: Added French and Italian catalogs.@{par}
Bug fix: tab filename completion wouldn't work if text gad filter was
set in IControl prefs.@{par}
Bug fix: Shift + Tab and other pattern matching operations would
remove the trailing slash '/' if the pattern used was something like
"Env:Sys/s*".@{par}
Bug fix: LANGUAGE keyword had no effect previously.@{par}
Bug fix: Changed key assignment of 'Output' gadget in Options window
(English catalog) to avoid clash with 'Okay' gadget.@{par}
Bug fix: Now requires only V37 of asl.library, not V38.@{par}
Changed: GUIDEFILE tooltype is now called GUIDENAME.@{par}
Changed: Removed BGUI library from distribution archive.@{par}
Changed: Guide enhanced with AmigaGuide V40 formatting commands, but
entirely compatible with older versions.@{par}
@{b}1.2 (22.12.95)@{ub}@{line}
@{b}--------------@{ub}@{par}
Bug fix: Completely screwed up locale catalog generation. Now it will
actually work with the supplied catalogs.@{par}
@endnode
@remark *********************************************************************
@node CreditsNode "ShellBench: Credits"
@{line}
@{b}@{fg shine}Credits@{fg text}@{ub}@{line}
@{b}@{fg shine}=======@{fg text}@{ub}@{par}
Thanks go to:@{par}
Jan van den Baard for BGUI.@{line}
Andre Reichl for the bug reports and useful suggestions.@{line}
Alessandro Basso for the Italian translation.@{line}
Julien Wilk for the French translation.@{line}
Pierre for the SystemTagList() call info.@{line}
Stefan Becker for the search path info.@{par}
ShellBench was developed with the following equipment:@{par}
@{code}
Hardware:
Amiga B2000rev6
Kickstart V37.175, Workbench V37.67
(later upgraded to Kick V40.63, WB V40.42)
ECS 1MB Agnus, OCS Denise
GVP G-Force EC030/882 @ 40MHz
10MB Fast RAM, 1MB Chip RAM
340MB SCSI HD (Fujitsu 2682S)
150MB Tapestreamer (TEAC MT-2ST/N50)
Philips CM8833 monitor (flicker, flicker...)
Software:
CygnusEdPro (Bruce Dawson, CygnusSoft)
SAS/C (The SAS Institute)
FlexCat (Jochen Wiedman)
BadLinks (Roger Nedel)
CSh (Urban M
ller and Andreas M. Kirchwitz)
Yak (Ga
l Marziou and Philippe Bastiani)
Xoper (Werner G
nther and Gunther Nikl)
@{body}
@endnode
@remark *********************************************************************
@node BGUINode "ShellBench: About BGUI"
@{line}
@{b}@{fg shine}About BGUI@{fg text}@{ub}@{line}
@{b}@{fg shine}==========@{fg text}@{ub}@{par}
@{code}
@{i}ShellBench uses@{ui}
@{b}BGUI@{ub}
(C) Copyright 1993-1994 Jaba Development
(C) Copyright 1993-1994 Jan van den Baard
Written using DICE v3.0 by
SNail: Jan van den Baard
Bakkerstraat 176
3082 HE Rotterdam
Holland
Fido: 2:286/407.53 (Jan van.den.Baard)
EMail: jaba@grafix.wlink.nl
EMail is preferred.
If you must use snail mail then please make it clear
when you absolutely need an anwser and (don't forget
this) include enough return postage.
@{body}
@{b}BGUI@{ub} is a BOOPSI based shared library contaning a number of BOOPSI
classes. It allows for easy creation and managing of font sensitive
and size adjustable GUI's on the Amiga.@{par}
@{b}BGUI@{ub} is a single library which can be removed as easely as it can be
installed. It provides an easy way to create and control GUI's without
becoming excessive in what it does.@{par}
@{b}BGUI@{ub} is GiftWare for people writing freely distributable software.
This means that if you want to use the programs you are morally
obligated to reward the author with a gift that, you think, matches
his efforts. If you cannot think of a gift (come on! be creative ;), a
small financial donation will always be gladly accepted.@{par}
ShareWare and/or commercial usage is @{b}not@{ub} allowed without:@{par}
@{lindent 2}
1) Prior written permission from the author.@{line}
2) A small financial donation of US$ 20,-, DM 30,- or HFL 30,-.@{line}
3) A free and registered copy of the product including free updates
that still make use of the library.@{line}
@{lindent 0}
@endnode
@remark *********************************************************************
@node AuthorNode "ShellBench: About the Author"
@{line}
@{b}@{fg shine}About the Author@{fg text}@{ub}@{line}
@{b}@{fg shine}================@{fg text}@{ub}@{par}
@{code}
I prefer to be reached at:
nick.christie@oucs.ox.ac.uk
but if you must use snail mail:
Nick Christie
39 St Georges Drive
Bransgore
BH23 8EZ
Great Britain
Response to email is generally assured and rapid; response to snail
mail is pretty haphazard.
You're welcome at my home page:
http://sable.ox.ac.uk/~nick
@{body}
@endnode
@remark *********************************************************************
(.txt)
(.txt)